Add documentation for creating nitlsconfig gRPC channels - #2210
Add documentation for creating nitlsconfig gRPC channels#2210alexdubois-ni wants to merge 1 commit into
Conversation
…rating with nimi-python gRPC APIs
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2210 +/- ##
=======================================
Coverage 88.09% 88.09%
=======================================
Files 88 88
Lines 22756 22756
=======================================
+ Hits 20047 20048 +1
+ Misses 2709 2708 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vnktshr21
left a comment
vnktshr21
left a comment
There was a problem hiding this comment.
You could just strike off the I've updated [CHANGELOG.md](https://github.com/ni/nimi-python/blob/master/CHANGELOG.md) if applicable. and I've added tests applicable for this pull request since they are not applicable for this PR.
| close it after the last session using it is closed. | ||
|
|
||
| The recommended way to create a gRPC channel to a remote system running NI gRPC Device Server is | ||
| ``create_grpc_device_channel`` from the `nitlsconfig <https://pypi.org/project/nitlsconfig/>`_ package, |
There was a problem hiding this comment.
If we had a readthedocs project setup for nitlsconfig, we could link to the documentation for this function.
See
nimi-python/docs/niscope/class.rst
Line 7480 in 5931056
nimi-python/docs/niscope/conf.py
Line 186 in 5931056
There was a problem hiding this comment.
FYI @ni-jfitzger, here are more intersphinx links for packages that this project may be using:
intersphinx_mapping = {
"hightime": ("https://hightime.readthedocs.io/en/latest/", None),
"grpc": ("https://grpc.github.io/grpc/python/", None),
"nitypes": ("https://nitypes.readthedocs.io/en/latest/", None),
"ni.grpcdevice.v1.proto": ("https://nigrpcdevicev1proto.readthedocs.io/en/latest/", None),
"ni-grpc-extensions": ("https://ni-grpc-extensions.readthedocs.io/en/latest/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"protobuf": ("https://googleapis.dev/python/protobuf/latest/", None),
}
5 participants
This contribution adheres to CONTRIBUTING.md.
[] I've updated CHANGELOG.md if applicable.This change is just documentation.
I've added tests applicable for this pull request
Purely documentation. No tests required.
What does this Pull Request accomplish?
Add public-facing documentation for how to use our new Python nitlsconfig package to create mTLS encrypted gRPC channels.
Add initial documentation as well for creating gRPC channels as well, including how to even install gRPC. Ensure we link to and add tidbits for how to get this setup even working in the first place since it has a fair bit of nuance.
List issues fixed by this Pull Request below, if any.
N/A
What testing has been done?
Checked the produced documentation: